<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>v_hscaler: Overview</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">v_hscaler
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__v__hscaler.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#nested-classes">Data Structures</a>  </div>
  <div class="headertitle">
<div class="title">Overview</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">H Scaler Layer 2 data.  <a href="struct_x_v___hscaler__l2.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="member-group"></a>
Hw Configuration</h2></td></tr>
<tr><td class="ititle" colspan="2"><p><a class="anchor" id="amgrpe07496529b2051c7e9395499f7cf4d41"></a>The following constants define the scaler HW MAX configuration </p>
</td></tr>
<tr class="memitem:ga93cbecf16c1c2b4af00d7779c02aacfb"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#ga93cbecf16c1c2b4af00d7779c02aacfb">XV_HSCALER_TYPE</a> </td></tr>
<tr class="memdesc:ga93cbecf16c1c2b4af00d7779c02aacfb"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef enumerates the Scaler Type.  <a href="group__v__hscaler.html#ga93cbecf16c1c2b4af00d7779c02aacfb">More...</a><br/></td></tr>
<tr class="separator:ga93cbecf16c1c2b4af00d7779c02aacfb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga3421a38c1ff14ad8815095f14f799ffc"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#ga3421a38c1ff14ad8815095f14f799ffc">XV_HSCALER_TAPS</a> </td></tr>
<tr class="memdesc:ga3421a38c1ff14ad8815095f14f799ffc"><td class="mdescLeft">&#160;</td><td class="mdescRight">This typedef enumerates the supported taps.  <a href="group__v__hscaler.html#ga3421a38c1ff14ad8815095f14f799ffc">More...</a><br/></td></tr>
<tr class="separator:ga3421a38c1ff14ad8815095f14f799ffc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaa56de9b8cf6d41a05c7fec3ce6d5adf2"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#gaa56de9b8cf6d41a05c7fec3ce6d5adf2">XV_HScalerInitialize</a> (<a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *InstancePtr, u16 DeviceId)</td></tr>
<tr class="memdesc:gaa56de9b8cf6d41a05c7fec3ce6d5adf2"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the core instance.  <a href="#gaa56de9b8cf6d41a05c7fec3ce6d5adf2">More...</a><br/></td></tr>
<tr class="separator:gaa56de9b8cf6d41a05c7fec3ce6d5adf2"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6b1d1d8a20f69d2cee85e6897e9e9224"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#ga6b1d1d8a20f69d2cee85e6897e9e9224">XV_HScalerStart</a> (<a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga6b1d1d8a20f69d2cee85e6897e9e9224"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function starts the horizontal scaler core.  <a href="#ga6b1d1d8a20f69d2cee85e6897e9e9224">More...</a><br/></td></tr>
<tr class="separator:ga6b1d1d8a20f69d2cee85e6897e9e9224"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga6af3378b35ee6e260a553a47debb1231"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#ga6af3378b35ee6e260a553a47debb1231">XV_HScalerStop</a> (<a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga6af3378b35ee6e260a553a47debb1231"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function stops the horizontal scaler core.  <a href="#ga6af3378b35ee6e260a553a47debb1231">More...</a><br/></td></tr>
<tr class="separator:ga6af3378b35ee6e260a553a47debb1231"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2d4f69120d87bc983e2c6b17e0df404b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#ga2d4f69120d87bc983e2c6b17e0df404b">XV_HScalerLoadExtCoeff</a> (<a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *InstancePtr, u16 num_phases, u16 num_taps, const short *Coeff)</td></tr>
<tr class="memdesc:ga2d4f69120d87bc983e2c6b17e0df404b"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function loads user defined filter coefficients in the scaler coefficient storage.  <a href="#ga2d4f69120d87bc983e2c6b17e0df404b">More...</a><br/></td></tr>
<tr class="separator:ga2d4f69120d87bc983e2c6b17e0df404b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gae6e04c78787b26aea73ce5c28b1d78b6"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#gae6e04c78787b26aea73ce5c28b1d78b6">XV_HScalerSetup</a> (<a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *InstancePtr, u32 HeightIn, u32 WidthIn, u32 WidthOut, u32 ColorFormatIn, u32 ColorFormatOut)</td></tr>
<tr class="memdesc:gae6e04c78787b26aea73ce5c28b1d78b6"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function configures the scaler core registers with the specified configuration parameters of the axi stream.  <a href="#gae6e04c78787b26aea73ce5c28b1d78b6">More...</a><br/></td></tr>
<tr class="separator:gae6e04c78787b26aea73ce5c28b1d78b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7e3786ef99dc9aeab864629c72e8f000"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#ga7e3786ef99dc9aeab864629c72e8f000">XV_HScalerDbgReportStatus</a> (<a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *InstancePtr)</td></tr>
<tr class="memdesc:ga7e3786ef99dc9aeab864629c72e8f000"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function prints H Scaler status on the console.  <a href="#ga7e3786ef99dc9aeab864629c72e8f000">More...</a><br/></td></tr>
<tr class="separator:ga7e3786ef99dc9aeab864629c72e8f000"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga546aba039ad913cfefc82e67ecac1506"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#ga546aba039ad913cfefc82e67ecac1506">XV_HScalerValidateConfig</a> (<a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *InstancePtr, u32 cformatIn, u32 cformatOut)</td></tr>
<tr class="memdesc:ga546aba039ad913cfefc82e67ecac1506"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function checks if the given input and output color formats are valid configuration parameters for this instance.  <a href="#ga546aba039ad913cfefc82e67ecac1506">More...</a><br/></td></tr>
<tr class="separator:ga546aba039ad913cfefc82e67ecac1506"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga4014e798ccf4c18aa307a7a4be3b3697"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga4014e798ccf4c18aa307a7a4be3b3697"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>XV_HSCALER_MAX_H_TAPS</b>&#160;&#160;&#160;(12)</td></tr>
<tr class="separator:ga4014e798ccf4c18aa307a7a4be3b3697"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga60b36d924aa351e8ebed09da8305e57b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga60b36d924aa351e8ebed09da8305e57b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>XV_HSCALER_MAX_H_PHASES</b>&#160;&#160;&#160;(64)</td></tr>
<tr class="separator:ga60b36d924aa351e8ebed09da8305e57b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga0f6c76f49d25dc7a73d738c4c4c95b24"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga0f6c76f49d25dc7a73d738c4c4c95b24"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>XV_HSCALER_MAX_LINE_WIDTH</b>&#160;&#160;&#160;(8192)</td></tr>
<tr class="separator:ga0f6c76f49d25dc7a73d738c4c4c95b24"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaef566c560e516ed443a77e3fec537bb9"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#gaef566c560e516ed443a77e3fec537bb9">XV_HscalerIs422Enabled</a>(InstancePtr)&#160;&#160;&#160;((InstancePtr)-&gt;Hsc.Config.Is422Enabled)</td></tr>
<tr class="memdesc:gaef566c560e516ed443a77e3fec537bb9"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro checks if Hscaler instance is enabled for 4:2:2 processing.  <a href="#gaef566c560e516ed443a77e3fec537bb9">More...</a><br/></td></tr>
<tr class="separator:gaef566c560e516ed443a77e3fec537bb9"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga18e533067e97fd0cc84e4bcc526cd41d"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#ga18e533067e97fd0cc84e4bcc526cd41d">XV_HscalerIs420Enabled</a>(InstancePtr)&#160;&#160;&#160;((InstancePtr)-&gt;Hsc.Config.Is420Enabled)</td></tr>
<tr class="memdesc:ga18e533067e97fd0cc84e4bcc526cd41d"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro checks if Hscaler instance is enabled for 4:2:0 processing.  <a href="#ga18e533067e97fd0cc84e4bcc526cd41d">More...</a><br/></td></tr>
<tr class="separator:ga18e533067e97fd0cc84e4bcc526cd41d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga00e59b30f96d1af6a212180de19a66a0"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__v__hscaler.html#ga00e59b30f96d1af6a212180de19a66a0">XV_HscalerIsCscEnabled</a>(InstancePtr)&#160;&#160;&#160;((InstancePtr)-&gt;Hsc.Config.IsCscEnabled)</td></tr>
<tr class="memdesc:ga00e59b30f96d1af6a212180de19a66a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">This macro checks if Hscaler instance is enabled for color space conversion.  <a href="#ga00e59b30f96d1af6a212180de19a66a0">More...</a><br/></td></tr>
<tr class="separator:ga00e59b30f96d1af6a212180de19a66a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga18e533067e97fd0cc84e4bcc526cd41d"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XV_HscalerIs420Enabled</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td>&#160;&#160;&#160;((InstancePtr)-&gt;Hsc.Config.Is420Enabled)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This macro checks if Hscaler instance is enabled for 4:2:0 processing. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is pointer to Hscaler core layer 2</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 1 if condition is TRUE or 0 if FALSE </dd></dl>

<p>Referenced by <a class="el" href="group__v__hscaler.html#ga7e3786ef99dc9aeab864629c72e8f000">XV_HScalerDbgReportStatus()</a>, and <a class="el" href="group__v__hscaler.html#ga546aba039ad913cfefc82e67ecac1506">XV_HScalerValidateConfig()</a>.</p>

</div>
</div>
<a class="anchor" id="gaef566c560e516ed443a77e3fec537bb9"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XV_HscalerIs422Enabled</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td>&#160;&#160;&#160;((InstancePtr)-&gt;Hsc.Config.Is422Enabled)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This macro checks if Hscaler instance is enabled for 4:2:2 processing. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is pointer to Hscaler core layer 2</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 1 if condition is TRUE or 0 if FALSE </dd></dl>

<p>Referenced by <a class="el" href="group__v__hscaler.html#ga7e3786ef99dc9aeab864629c72e8f000">XV_HScalerDbgReportStatus()</a>, and <a class="el" href="group__v__hscaler.html#ga546aba039ad913cfefc82e67ecac1506">XV_HScalerValidateConfig()</a>.</p>

</div>
</div>
<a class="anchor" id="ga00e59b30f96d1af6a212180de19a66a0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">#define XV_HscalerIsCscEnabled</td>
          <td>(</td>
          <td class="paramtype">&#160;</td>
          <td class="paramname">InstancePtr</td><td>)</td>
          <td>&#160;&#160;&#160;((InstancePtr)-&gt;Hsc.Config.IsCscEnabled)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This macro checks if Hscaler instance is enabled for color space conversion. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is pointer to Hscaler core layer 2</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Returns 1 if condition is TRUE or 0 if FALSE </dd></dl>

<p>Referenced by <a class="el" href="group__v__hscaler.html#ga7e3786ef99dc9aeab864629c72e8f000">XV_HScalerDbgReportStatus()</a>, and <a class="el" href="group__v__hscaler.html#ga546aba039ad913cfefc82e67ecac1506">XV_HScalerValidateConfig()</a>.</p>

</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga3421a38c1ff14ad8815095f14f799ffc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__hscaler.html#ga3421a38c1ff14ad8815095f14f799ffc">XV_HSCALER_TAPS</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This typedef enumerates the supported taps. </p>

</div>
</div>
<a class="anchor" id="ga93cbecf16c1c2b4af00d7779c02aacfb"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="group__v__hscaler.html#ga93cbecf16c1c2b4af00d7779c02aacfb">XV_HSCALER_TYPE</a></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This typedef enumerates the Scaler Type. </p>

</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga7e3786ef99dc9aeab864629c72e8f000"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HScalerDbgReportStatus </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function prints H Scaler status on the console. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is the instance pointer to the core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__hscaler___config.html#a696d45aced9351708a56107e1b336e26">XV_hscaler_Config::BaseAddress</a>, <a class="el" href="struct_x_v__hscaler.html#a593e6539aa573e9b57c5126b8db1cc5b">XV_hscaler::Config</a>, <a class="el" href="struct_x_v__hscaler___config.html#aa46e23594ec1f8647bed471bc8d5fa98">XV_hscaler_Config::NumTaps</a>, <a class="el" href="struct_x_v__hscaler___config.html#a4282b794e8c469aa0c50cb28b3e282cd">XV_hscaler_Config::PhaseShift</a>, <a class="el" href="struct_x_v__hscaler___config.html#a9b8f1147b245bb2a6af561ce87b161aa">XV_hscaler_Config::ScalerType</a>, <a class="el" href="group__v__hscaler.html#ga18e533067e97fd0cc84e4bcc526cd41d">XV_HscalerIs420Enabled</a>, <a class="el" href="group__v__hscaler.html#gaef566c560e516ed443a77e3fec537bb9">XV_HscalerIs422Enabled</a>, and <a class="el" href="group__v__hscaler.html#ga00e59b30f96d1af6a212180de19a66a0">XV_HscalerIsCscEnabled</a>.</p>

</div>
</div>
<a class="anchor" id="gaa56de9b8cf6d41a05c7fec3ce6d5adf2"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XV_HScalerInitialize </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>DeviceId</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the core instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to core instance to be worked upon </td></tr>
    <tr><td class="paramname">DeviceId</td><td>is instance id of the core</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if device is found and initialized XST_DEVICE_NOT_FOUND if device is not found </dd></dl>

</div>
</div>
<a class="anchor" id="ga2d4f69120d87bc983e2c6b17e0df404b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HScalerLoadExtCoeff </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>num_phases</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u16&#160;</td>
          <td class="paramname"><em>num_taps</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const short *&#160;</td>
          <td class="paramname"><em>Coeff</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function loads user defined filter coefficients in the scaler coefficient storage. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">num_phases</td><td>is the number of phases in coefficient table </td></tr>
    <tr><td class="paramname">num_taps</td><td>is the number of taps in coefficient table </td></tr>
    <tr><td class="paramname">Coeff</td><td>is a pointer to user defined filter coefficients table</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

<p>References <a class="el" href="struct_x_v__hscaler.html#a593e6539aa573e9b57c5126b8db1cc5b">XV_hscaler::Config</a>, and <a class="el" href="struct_x_v__hscaler___config.html#a4282b794e8c469aa0c50cb28b3e282cd">XV_hscaler_Config::PhaseShift</a>.</p>

</div>
</div>
<a class="anchor" id="gae6e04c78787b26aea73ce5c28b1d78b6"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XV_HScalerSetup </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>HeightIn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>WidthIn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>WidthOut</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ColorFormatIn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ColorFormatOut</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function configures the scaler core registers with the specified configuration parameters of the axi stream. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">HeightIn</td><td>is the input stream height </td></tr>
    <tr><td class="paramname">WidthIn</td><td>is the input stream width </td></tr>
    <tr><td class="paramname">WidthOut</td><td>is the output stream width </td></tr>
    <tr><td class="paramname">ColorFormatIn</td><td>is the input stream color format </td></tr>
    <tr><td class="paramname">ColorFormatOut</td><td>is the output stream color format</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>XST_SUCCESS if the requested setup parameters are valid XST_FAILURE otherwise </dd></dl>

<p>References <a class="el" href="struct_x_v__hscaler.html#a593e6539aa573e9b57c5126b8db1cc5b">XV_hscaler::Config</a>, <a class="el" href="struct_x_v__hscaler___config.html#a074a3b3e53bcbdc9510a82418d5df552">XV_hscaler_Config::PixPerClk</a>, <a class="el" href="struct_x_v__hscaler___config.html#a9b8f1147b245bb2a6af561ce87b161aa">XV_hscaler_Config::ScalerType</a>, and <a class="el" href="group__v__hscaler.html#ga546aba039ad913cfefc82e67ecac1506">XV_HScalerValidateConfig()</a>.</p>

</div>
</div>
<a class="anchor" id="ga6b1d1d8a20f69d2cee85e6897e9e9224"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HScalerStart </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function starts the horizontal scaler core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="ga6af3378b35ee6e260a553a47debb1231"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void XV_HScalerStop </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function stops the horizontal scaler core. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>None </dd></dl>

</div>
</div>
<a class="anchor" id="ga546aba039ad913cfefc82e67ecac1506"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XV_HScalerValidateConfig </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_v___hscaler__l2.html">XV_Hscaler_l2</a> *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>cformatIn</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>cformatOut</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function checks if the given input and output color formats are valid configuration parameters for this instance. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the core instance to be worked on. </td></tr>
    <tr><td class="paramname">cformat</td><td>is the input stream color format </td></tr>
    <tr><td class="paramname">cformatOut</td><td>is the output stream color format</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>TRUE if the requested setup parameters are valid FALSE otherwise </dd></dl>

<p>References <a class="el" href="group__v__hscaler.html#ga18e533067e97fd0cc84e4bcc526cd41d">XV_HscalerIs420Enabled</a>, <a class="el" href="group__v__hscaler.html#gaef566c560e516ed443a77e3fec537bb9">XV_HscalerIs422Enabled</a>, and <a class="el" href="group__v__hscaler.html#ga00e59b30f96d1af6a212180de19a66a0">XV_HscalerIsCscEnabled</a>.</p>

<p>Referenced by <a class="el" href="group__v__hscaler.html#gae6e04c78787b26aea73ce5c28b1d78b6">XV_HScalerSetup()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
